ci: re-add document generation to release#989
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds document generation as a separate step in the release workflow. The change refactors the existing document handling by introducing a new generate-documents job that calls a reusable workflow, while updating the upload-documents job to depend on this new job instead of the broader build-push-test job.
- Introduces a new
generate-documentsjob that delegates towc-document-generation.yml - Updates the
upload-documentsjob dependency frombuild-push-testtogenerate-documents
|
✅
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| ✅ ACTION | actionlint | 22 | 0 | 0 | 0.45s | |
| ✅ DOCKERFILE | hadolint | 2 | 0 | 0 | 0.79s | |
| ✅ GHERKIN | gherkin-lint | 6 | 0 | 0 | 2.27s | |
| ✅ JSON | npm-package-json-lint | yes | no | no | 0.48s | |
| ✅ JSON | prettier | 15 | 2 | 0 | 0 | 0.54s |
| ✅ JSON | v8r | 15 | 0 | 0 | 7.19s | |
| ✅ MARKDOWN | markdownlint | 11 | 0 | 0 | 0 | 0.89s |
| ✅ MARKDOWN | markdown-table-formatter | 11 | 0 | 0 | 0 | 0.21s |
| ✅ REPOSITORY | gitleaks | yes | no | no | 0.92s | |
| ✅ REPOSITORY | git_diff | yes | no | no | 0.01s | |
| ✅ REPOSITORY | grype | yes | no | no | 28.18s | |
| ✅ REPOSITORY | secretlint | yes | no | no | 0.98s | |
| ✅ REPOSITORY | syft | yes | no | no | 1.96s | |
| ✅ REPOSITORY | trivy | yes | no | no | 5.65s | |
| ✅ REPOSITORY | trivy-sbom | yes | no | no | 0.24s | |
| ✅ REPOSITORY | trufflehog | yes | no | no | 2.38s | |
| lychee | 73 | 1 | 0 | 23.44s | ||
| ✅ YAML | prettier | 28 | 0 | 0 | 0 | 1.17s |
| ✅ YAML | v8r | 28 | 0 | 0 | 8.12s | |
| ✅ YAML | yamllint | 28 | 0 | 0 | 0.92s |
Detailed Issues
⚠️ SPELL / lychee - 1 error
[IGNORED] docker://pandoc/extra:3.7.0@sha256:a703d335fa237f8fc3303329d87e2555dca5187930da38bfa9010fa4e690933a | Unsupported: Error creating request client: builder error for url (docker://pandoc/extra:3.7.0@sha256:a703d335fa237f8fc3303329d87e2555dca5187930da38bfa9010fa4e690933a)
[ERROR] https://slsa.dev/spec/v1.0/threats | Network error: error sending request for url (https://slsa.dev/spec/v1.0/threats) Maybe a certificate error?
[IGNORED] https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/philips-software/amp-devcontainer | Unsupported: Error creating request client: builder error for url (vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/philips-software/amp-devcontainer)
📝 Summary
---------------------
🔍 Total..........122
✅ Successful.....119
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
❓ Unknown..........0
🚫 Errors...........1
Errors in test/cpp/features/security.feature
[ERROR] https://slsa.dev/spec/v1.0/threats | Network error: error sending request for url (https://slsa.dev/spec/v1.0/threats) Maybe a certificate error?
See detailed reports in MegaLinter artifacts
Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)
- Documentation: Custom Flavors
- Command:
npx mega-linter-runner@9.1.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,DOCKERFILE_HADOLINT,GHERKIN_GHERKIN_LINT,JSON_V8R,JSON_PRETTIER,JSON_NPM_PACKAGE_JSON_LINT,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_GIT_DIFF,REPOSITORY_GITLEAKS,REPOSITORY_GRYPE,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Pull Request Report (#989)Static measures
Time related measures
Status check related measures
|
|
🎉 Hooray! The changes in this pull request went live with the release of v6.5.3 🎉 |




🚀 Hey, I have created a Pull Request
Description of changes
This PR fixes the broken document generation for releases after the recent workflow refactoring. During the release build no document were generated because of a missing step, and thus the publishing of documents failed.
✔️ Checklist